Repository navigation
docs(style): clarify punctuation rules and edit scope - #74
Merged
Merged
Conversation
Forbid introducing em dashes and discourage semicolons in new or rewritten Markdown prose. Favor natural sentence structure while preserving meaning, technical syntax, quotations, and existing text outside the requested scope. Align repository guidance, the plugin skill, consumer templates, published documentation, and consumer adoption notes. Closes #33 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 40bf5936-fdf2-408a-afe7-dd07b66ed7da
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Discussion Link
Link: No GitHub Discussion is linked. The change was requested in #33, with the semicolon and edit-scope refinements approved during implementation.
Context
The existing documentation rule only prohibits dashes as separators between concepts. It does not explicitly prohibit introducing the em-dash character elsewhere in generated Markdown. Additional guidance is needed to avoid semicolon-heavy prose without encouraging choppy sentences or unrelated edits to existing documents.
Closes #33
Solution
Validation:
markdownlint .github/instructions/documentation-style.instructions.md .github/plugins/devsquad/hooks/templates/.github/instructions/documentation-style.instructions.md .github/plugins/devsquad/skills/documentation-style/SKILL.md CHANGELOG.md: passed.bash .github/plugins/devsquad/hooks/sdd-init.sh verify: completed with valid JSON. Existing customized-file drift and four missing artifact-template targets were present before this change and remain unchanged.npm --prefix docs run build: passed, 39 pages built.git diff --check: passed before commit.No repository-wide punctuation cleanup, enforcement hook, or version bump is included. Existing consumers can apply the scoped rules manually or preview managed-file updates before applying them.
Checklist